Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update filenames #60

Merged
merged 13 commits into from
Mar 23, 2024
Merged

update filenames #60

merged 13 commits into from
Mar 23, 2024

Conversation

alkaZeltser
Copy link
Collaborator

Description

Closes #36
Standardize output filenames.

Testing Results

My nftests are currently failing because the .sha512 checksum files include the name of the file, which of course doesn't match the test cases. However the checksum hashes themselves are identical. It's a bit odd that nftest compares checksum files by making checksums of the checksums. I can update the test cases but is there a better way to do this? Does nftest support checksum comparison when the test case itself is a checksum?

Also, do I need to update the test case filenames to match the new filenames? If so, I shall await feedback on correctness of current filenames before updating.

  • Case 1
    • sample: A-mini-n2
    • output: /hot/software/pipeline/pipeline-calculate-targeted-coverage/Nextflow/development/unreleased/nzeltser-update-filenames/TWGSAMIN000001-T002-S02-F/calculate-targeted-coverage-1.0.0-rc.2/

Checklist

  • I have read the code review guidelines and the code review best practice on GitHub check-list.

  • I have reviewed the Nextflow pipeline standards.

  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].

  • I have set up or verified the branch protection rule following the github standards before opening this pull request.

  • I have added my name to the contributors listings in the manifest block in the nextflow.config as part of this pull request, am listed
    already, or do not wish to be listed. (This acknowledgement is optional.)

  • I have added the changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

  • I have updated the version number in the metadata.yaml and manifest block of the nextflow.config file following semver, or the version number has already been updated. (Leave it unchecked if you are unsure about new version number and discuss it with the infrastructure team in this PR.)

  • I have tested the pipeline on at least one A-mini sample.

@alkaZeltser alkaZeltser requested a review from yashpatel6 March 21, 2024 00:34
Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of things:

module/run_HS_metrics.nf Outdated Show resolved Hide resolved
nftest.yml Outdated Show resolved Hide resolved
@alkaZeltser
Copy link
Collaborator Author

Tests pass!

2024-03-21 19:44:02,974 - NFTest - INFO - Completed at: 21-Mar-2024 12:44:02
2024-03-21 19:44:03,175 - NFTest - INFO - Duration    : 6m 57s
2024-03-21 19:44:03,175 - NFTest - INFO - CPU hours   : 0.1
2024-03-21 19:44:03,175 - NFTest - INFO - Succeeded   : 16
2024-03-21 19:44:03,175 - NFTest - INFO - 
2024-03-21 19:44:03,175 - NFTest - INFO - 
2024-03-21 19:44:09,664 - NFTest - INFO -  [ succeed ]

@alkaZeltser alkaZeltser requested a review from yashpatel6 March 21, 2024 21:00
Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of record-keeping things: CHANGELOG should be updated and the output section in the README should be updated to match the standardized filenames

@nwiltsie for the config test, I'm not sure if it's expected but the comments in files changed are still appearing even after the test passes?

@alkaZeltser
Copy link
Collaborator Author

Couple of record-keeping things: CHANGELOG should be updated and the output section in the README should be updated to match the standardized filenames

Done! (I think) Was there anything else that needed to be changed in the README? I just made minor tweaks, all the unique file identifiers are still pretty much the same as before.

Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good!

@alkaZeltser alkaZeltser merged commit 34d075c into main Mar 23, 2024
4 checks passed
@alkaZeltser alkaZeltser deleted the nzeltser-update-filenames branch March 23, 2024 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardize output filenames
2 participants